Scripting > CxHmiGrp > CxGrpGrid Object

CxGrpGrid Object

The CxGrpGrid object is used to display and manipulate the CxHmiGrp control. It can be used in conjunction with the CxGrpNavBar object. Declare the object using the following code:

CreateObject("CxHmiGrp.CxGrpGrid")

If using the intrinsic CygNet Studio Group Grid object, all methods and properties must be preceded by X. (e.g, this.x.print).

The Group Grid Control is an ActiveX control that displays a grid with rows that represent Facilities and columns that represent Uniform Data Codes (UDCs) in its typical usage. The information displayed in a cell at the intersection of a row and column represents a point that is identified by the Site.Service and Facility from the row, and the UDC from the column.

The display of rows and columns is dynamic as there are powerful features that allow the user to sort the rows by content and show, hide, and reorder the columns. Because of this dynamic nature, the column and row coordinates used in the scripting environment always represent the coordinates as configured ("data" coordinates) rather than as displayed ("grid" coordinates).

The script writer is cautioned that an event that provides a Row or Column coordinate, such as the OnLClick event, will pass the "data" coordinates which may not match the "grid" coordinates of the cell that was clicked. The "data" coordinates can, however, be safely passed to any of the methods or properties that accept a Column and/or Row parameter and the correct information will be returned.

In the container’s Design Mode, the control is configured using the containing host environment. When the container is in its Run mode, the control is in either the "Started" or "Stopped" state. In the descriptions below the "Started" state is referred to as "Run mode".

The grid is started automatically if the AutoStart property is enabled. Otherwise, it must be started by calling the Start method. When the grid is started, the Grid, Row, and Column configurations are combined to configure the grid cells. Changes to the Grid, Row, and Column configurations do not take effect until the grid is restarted by calling the Restart method.

A typical scenario for configuring a grid using script is as follows:


More:


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.